docs: use links instead of <xref>
authorWilliam Jon McCann <william.jon.mccann@gmail.com>
Fri, 7 Feb 2014 16:12:43 +0000 (11:12 -0500)
committerWilliam Jon McCann <william.jon.mccann@gmail.com>
Fri, 7 Feb 2014 16:13:11 +0000 (11:13 -0500)
16 files changed:
gdk/gdkkeys.c
gdk/gdkpango.c
gdk/gdkwindow.h
gtk/deprecated/gtkaction.c
gtk/deprecated/gtkhbox.c
gtk/deprecated/gtkrc.c
gtk/deprecated/gtkstock.c
gtk/deprecated/gtkvbox.c
gtk/gtkcssprovider.c
gtk/gtkfilechooser.c
gtk/gtkicontheme.c
gtk/gtkimage.h
gtk/gtkimcontext.c
gtk/gtkstylecontext.c
gtk/gtkwidget.c
gtk/gtkwidget.h

index 5ead1671613a144d084598a53d9fa18300d7f998..e3297dc7878b9afa44ca9a8c8a5f4b44ab75795d 100644 (file)
@@ -488,7 +488,7 @@ gdk_keymap_lookup_key (GdkKeymap          *keymap,
  * group, and level. Modifiers that affected the translation and
  * are thus unavailable for application use are returned in
  * @consumed_modifiers.
- * See <xref linkend="key-group-explanation"/> for an explanation of
+ * See [Groups][key-group-explanation] for an explanation of
  * groups and levels. The @effective_group is the group that was
  * actually used for the translation; some keys such as Enter are not
  * affected by the active keyboard group. The @level is derived from
index cff8690493e9f2aa89ee7a81b3e872a67f7e1a83..7b5227e107b8dad31844b71f450f0e213d0f3a54 100644 (file)
  * g_object_unref (context);
  * ]|
  *
- * ## Output of <xref linkend="rotated-example"/>
+ * ## Output of the [example][rotated-example] above.
  *
  * ![](rotated-text.png)
  */
index 87f9fde430bdca83176145f8c9fe0925432ff371..b3287d7c599714b85cc28e4035aa716af8d0dbf2 100644 (file)
@@ -67,7 +67,7 @@ typedef enum
  *  #GtkMenu)
  * @GDK_WINDOW_FOREIGN: foreign window (see gdk_window_foreign_new())
  * @GDK_WINDOW_OFFSCREEN: offscreen window (see
- *  <xref linkend="OFFSCREEN-WINDOWS"/>). Since 2.18
+ *  [Offscreen Windows][OFFSCREEN-WINDOWS]). Since 2.18
  *
  * Describes the kind of window.
  */
index e0b1367f5acb1f2efeabd0606f55aeb9da28d77c..b9630ae2b3887345cbc4c7918d9058ff9123a72b 100644 (file)
@@ -618,7 +618,7 @@ gtk_action_buildable_get_name (GtkBuildable *buildable)
  * Creates a new #GtkAction object. To add the action to a
  * #GtkActionGroup and set the accelerator for the action,
  * call gtk_action_group_add_action_with_accel().
- * See <xref linkend="XML-UI"/> for information on allowed action
+ * See the [UI Definition section][XML-UI] for information on allowed action
  * names.
  *
  * Return value: a new #GtkAction
index 5c6b3cad6d3980ce7573a0e0b3aee7fed1930e3e..77ede7f2398f44899b4b269364eb48d2f94349d9 100644 (file)
@@ -53,7 +53,7 @@ G_GNUC_BEGIN_IGNORE_DEPRECATIONS
  * If you don't need first-child or last-child styling, and want your code
  * to be future-proof, the recommendation is to switch to #GtkGrid instead
  * of nested boxes. For more information about migrating to #GtkGrid,
- * see <xref linkend="gtk-migrating-GtkGrid"/>
+ * see [Migrating from other containers to GtkGrid][gtk-migrating-GtkGrid].
  */
 
 
@@ -85,7 +85,7 @@ gtk_hbox_init (GtkHBox *hbox)
  * Deprecated: 3.2: You can use gtk_box_new() with %GTK_ORIENTATION_HORIZONTAL instead,
  *   which is a quick and easy change. But the recommendation is to switch to
  *   #GtkGrid, since #GtkBox is going to go away eventually.
- *   See <xref linkend="gtk-migrating-GtkGrid"/>.
+ *   See [Migrating from other containers to GtkGrid][gtk-migrating-GtkGrid].
  */
 GtkWidget *
 gtk_hbox_new (gboolean homogeneous,
index c4494dff55614e31ab839f39996d6444ce449b99..8c27040b3ecff32fb9d3fa64e5949c4349e6ee8a 100644 (file)
@@ -907,8 +907,7 @@ gtk_rc_get_theme_dir (void)
  *
  * Returns a directory in which GTK+ looks for theme engines.
  * For full information about the search for theme engines,
- * see the docs for `GTK_PATH` in
- * <xref linkend="gtk-running"/>.
+ * see the docs for `GTK_PATH` in [Running GTK+ Applications][gtk-running].
  *
  * return value: (type filename): the directory. (Must be freed with g_free())
  *
index 8c00b4d3f0ec35c7ccf80297958a5d9f4fd4681e..245d213c4cc17ab491bdacfaf82819d2a44d7cd6 100644 (file)
@@ -49,8 +49,7 @@ Prebuilt common menu/toolbar items and corresponding icons
  * Each stock ID can be associated with a #GtkStockItem, which contains
  * the user-visible label, keyboard accelerator, and translation domain
  * of the menu or toolbar item; and/or with an icon stored in a
- * #GtkIconFactory. See [GtkIconFactory][gtk3-Themeable-Stock-Images] for
- * more information on stock icons. The connection between a
+ * #GtkIconFactory. The connection between a
  * #GtkStockItem and stock icons is purely conventional (by virtue of
  * using the same stock ID); it's possible to register a stock item but
  * no icon, and vice versa. Stock icons may have a RTL variant which gets
index 6a95410ae8982544511df7170a80d5d3e48b9248..c28f6387b65348aeb5f7bf5215502f3f3e71aa8b 100644 (file)
@@ -58,7 +58,7 @@ G_GNUC_BEGIN_IGNORE_DEPRECATIONS
  * If you don't need first-child or last-child styling and want your code
  * to be future-proof, the recommendation is to switch to #GtkGrid instead
  * of nested boxes. For more information about migrating to #GtkGrid,
- * see <xref linkend="gtk-migrating-GtkGrid"/>.
+ * see [Migrating from other containers to GtkGrid][gtk-migrating-GtkGrid].
  */
 
 G_DEFINE_TYPE (GtkVBox, gtk_vbox, GTK_TYPE_BOX)
@@ -89,7 +89,7 @@ gtk_vbox_init (GtkVBox *vbox)
  * Deprecated: 3.2: You can use gtk_box_new() with %GTK_ORIENTATION_VERTICAL instead,
  *   which is a quick and easy change. But the recommendation is to switch to
  *   #GtkGrid, since #GtkBox is going to go away eventually.
- *   See <xref linkend="gtk-migrating-GtkGrid"/>.
+ *   See [Migrating from other containers to GtkGrid][gtk-migrating-GtkGrid].
  */
 GtkWidget *
 gtk_vbox_new (gboolean homogeneous,
index eeb3e07ed7f4dcd22c8792704d996f8966ed18e1..04cfab345767c06a4ed6da9af74533617c1b4f20 100644 (file)
  * character.
  *
  * Refer to the documentation of individual widgets to learn which
- * style classes they define and see <xref linkend="gtkstylecontext-classes"/>
+ * style classes they define and see
+ * [Style Classes and Regions][gtkstylecontext-classes]
  * for a list of all style classes used by GTK+ widgets.
  *
  * Note that there is some ambiguity in the selector syntax when it comes
  *
  * Refer to the documentation of individual widgets to learn which
  * regions and pseudo-classes they define and see
- * <xref linkend="gtkstylecontext-classes"/> for a list of all regions
+ * [Style Classes and Regions][gtkstylecontext-classes]
+ * for a list of all regions
  * used by GTK+ widgets.
  *
  * An example for regions in selectors:
index d088f0b375b4bbaf1032fff2cdf4819cfc410131..90bc88a3a21d2a0b45ba72b8ce155f91ec8aba41 100644 (file)
@@ -92,7 +92,7 @@
  * flag that indicates whether your callback could successfully
  * generate a preview.
  *
- * ## An example for using a preview widget ## {#gtkfilechooser-preview}
+ * ## Example: Using a Preview Widget ## {#gtkfilechooser-preview}
  * |[<!-- language="C" -->
  * {
  *   GtkImage *preview;
@@ -253,7 +253,8 @@ gtk_file_chooser_default_init (GtkFileChooserInterface *iface)
    * must call gtk_file_chooser_set_preview_widget_active() to inform the file
    * chooser about whether the preview was generated successfully or not.
    *
-   * Please see the example code in <xref linkend="gtkfilechooser-preview"/>.
+   * Please see the example code in
+   * [Using a Preview Widget][gtkfilechooser-preview].
    *
    * See also: gtk_file_chooser_set_preview_widget(),
    * gtk_file_chooser_set_preview_widget_active(),
index a89683cdf8fe88072065f6abf7183fad1efd21e2..08d3aba8625ea1b8d6b3c92711791a371dab489d 100644 (file)
  * their icons, but more additional application themes can be
  * installed as operating system vendors and users choose.
  *
- * Named icons are similar to the <xref linkend="gtk3-Themeable-Stock-Images"/>
- * facility, and the distinction between the two may be a bit confusing.
+ * Named icons are similar to the deprecated [Stock Items][gtkstock],
+ * and the distinction between the two may be a bit confusing.
  * A few things to keep in mind:
  * 
  * - Stock images usually are used in conjunction with
- *   <xref linkend="gtk3-Stock-Items"/>, such as %GTK_STOCK_OK or
+ *   [Stock Items][gtkstock], such as %GTK_STOCK_OK or
  *   %GTK_STOCK_OPEN. Named icons are easier to set up and therefore
  *   are more useful for new icons that an application wants to
  *   add, such as application icons or window icons.
index 18e26e25a62c2b720e9b1af60b277f79a9b7f6fd..3e18fa5eb621e5fa6295c0be2ff308d36ecefd1a 100644 (file)
@@ -52,8 +52,7 @@ typedef struct _GtkImageClass         GtkImageClass;
  * GtkImageType:
  * @GTK_IMAGE_EMPTY: there is no image displayed by the widget
  * @GTK_IMAGE_PIXBUF: the widget contains a #GdkPixbuf
- * @GTK_IMAGE_STOCK: the widget contains a stock icon name (see
- *  <xref linkend="gtk3-Stock-Items"/>)
+ * @GTK_IMAGE_STOCK: the widget contains a [stock item name][gtkstock]
  * @GTK_IMAGE_ICON_SET: the widget contains a #GtkIconSet
  * @GTK_IMAGE_ANIMATION: the widget contains a #GdkPixbufAnimation
  * @GTK_IMAGE_ICON_NAME: the widget contains a named icon.
index 4b17b2aea6f51e607bd8cb412445853e22b82b71..e2c3257a195e455b32ed597feb4fa5b42dbed0cf 100644 (file)
@@ -35,7 +35,8 @@
  *
  * The default input method can be set programmatically via the 
  * #GtkSettings:gtk-im-module GtkSettings property. Alternatively, you may set 
- * the GTK_IM_MODULE environment variable as documented in #gtk-running.
+ * the GTK_IM_MODULE environment variable as documented in
+ * [Running GTK+ Applications][gtk-running].
  *
  * The #GtkEntry #GtkEntry:im-module and #GtkTextView #GtkTextView:im-module 
  * properties may also be used to set input methods for specific widget 
index 5cabff2b7f5311c9ead2e4084dd548b3d30557aa..4a63c9e928cff538f0e9345a6582851080c336e5 100644 (file)
@@ -75,7 +75,7 @@
  * #GtkSettings:gtk-theme-name setting or a hierarchy change in the rendered
  * widget.
  *
- * # Transition animations
+ * # Transition Animations
  *
  * #GtkStyleContext has built-in support for state change transitions.
  * Note that these animations respect the #GtkSettings:gtk-enable-animations
  * special value, in this case, the whole widget area will be updated
  * by the animation.
  *
- * # Style classes and regions # {#gtkstylecontext-classes}
+ * # Style Classes and Regions # {#gtkstylecontext-classes}
  *
  * Widgets can add style classes to their context, which can be used
- * to associate different styles by class (see <xref linkend="gtkcssprovider-selectors"/>).
+ * to associate different styles by class
+ * (see [Selectors][gtkcssprovider-selectors]).
  * Theme engines can also use style classes to vary their rendering.
  *
  * Widgets can also add regions with flags to their context.
index a599b13af0e2b85a7f7d66c14112365cd26c4ad2..e882bb2b885aa221ac5e5afc36b9c98f139abe99 100644 (file)
@@ -3312,7 +3312,8 @@ G_GNUC_END_IGNORE_DEPRECATIONS
    * menu. This usually happens through the standard key binding mechanism;
    * by pressing a certain key while a widget is focused, the user can cause
    * the widget to pop up a menu.  For example, the #GtkEntry widget creates
-   * a menu with clipboard commands. See <xref linkend="checklist-popup-menu"/>
+   * a menu with clipboard commands. See the
+   * [Popup Menu Migration Checklist][checklist-popup-menu]
    * for an example of how to use this signal.
    *
    * Returns: %TRUE if a menu was activated
index 20cdf462db74fb7be16d51b190585d39ce95266f..31a0a5195fe3425f890c9b7c88ddd245540edf10 100644 (file)
@@ -77,7 +77,8 @@ typedef struct _GtkWidgetAuxInfo       GtkWidgetAuxInfo;
  *
  * A #GtkAllocation-struct of a widget represents region
  * which has been allocated to the widget by its parent. It is a subregion
- * of its parents allocation. See <xref linkend="geometry-management"/> for
+ * of its parents allocation. See
+ * [GtkWidget's geometry management section][geometry-management] for
  * more information.
  */
 typedef        GdkRectangle       GtkAllocation;
@@ -116,7 +117,8 @@ typedef gboolean (*GtkTickCallback) (GtkWidget     *widget,
  * @height: the widget's desired height
  *
  * A #GtkRequisition-struct represents the desired size of a widget. See
- * <xref linkend="geometry-management"/> for more information.
+ * [GtkWidget's geometry management section][geometry-management] for
+ * more information.
  */
 struct _GtkRequisition
 {